home *** CD-ROM | disk | FTP | other *** search
/ Graphics Plus / Graphics Plus.iso / msdos / fractal / frasr182 / fractsrc.doc < prev    next >
Text File  |  1992-09-12  |  18KB  |  428 lines

  1. The source code for Fractint is freely available.
  2.  
  3. Enhancements to it are appreciated.  If you want to add something to
  4. Fractint and join the Stone Soup Group, please do!  To submit changes,
  5. see "Contacting the Authors" in Fractint's online help.
  6.  
  7.  
  8. Copyright Information:
  9. ======================
  10.  
  11. Some parts of the source are from the public domain and are not
  12. copyrighted.
  13.  
  14. Some parts of the source bear explicit copyright notices from the
  15. author and are subject to the conditions listed there by the author.
  16.  
  17. The remainder of the source (not already public domain, no explicit
  18. author's copyright notice) is Copyright 1990, 1991 by the Stone Soup Group
  19. (a loosely associated and ever-growing group of fanatic programmers).
  20.  
  21. The source code may be copied freely and may be used in other programs
  22. under the following conditions:
  23.   It may not be used in a commercial program which produces fractal images.
  24.   Please credit the author (in general, credit Fractint and the Stone Soup
  25.   Group) as the source of the code.
  26.  
  27.  
  28. Distribution of modified versions of Fractint:
  29. ==============================================
  30.  
  31. If you enhance Fractint and want to distribute the results to others, the
  32. preferred approach is to join the Stone Soup Group - send us your
  33. enhancements and get your name in lights in future versions of Fractint.
  34.  
  35. We prefer that a modified Fractint executable program not be distributed to
  36. others, but understand that you might want to give copies to friends.  This
  37. is permitted, under the following conditions:
  38.   o The modified executable has a different name than "fractint.exe".
  39.   o The distribution includes a full unmodified copy of the corresponding
  40.     original version of fraint.exe.  (The easiest way is to copy fraint.exe
  41.     to yournew.exe, then "pkzip -a fraint.exe newfract.exe" to add your
  42.     version, and perhaps add a read.me file to describe it.)
  43.   o The heading displayed by the modified program clearly indicates that
  44.     it is a non-standard release.  E.g. you might change the heading to
  45.     say "Non-standard Fractint, Modified by John Doe".
  46.   o All author credits and distribution information in the online help
  47.     are unchanged (adding lines for your work is of course ok.)
  48.  
  49. The source code for a modified version of Fractint may not be distributed.
  50. (This is because we don't want any chance of confusion over which version
  51. of a source file is the official release.)
  52.  
  53.  
  54. Compiling Fractint:
  55. ===================
  56.  
  57. FRASRC.EXE includes the complete source code for FRACTINT (.C and .ASM).
  58. Recognizing that not everyone HAS (or even wants) an assembler, much less
  59. either MASM 5.1 or Turbo-ASM, which are the only two assemblers that the
  60. authors are aware of that can handle these particular files, it also contains
  61. a complete set of .OBJ files from the assembler code,
  62.  
  63. The distributed source will not compile to exactly match the Fractint
  64. release - it compiles with a different version number and heading.
  65.  
  66. The Microsoft 6.00A C compiler and Microsoft 5.1 assembler are used for
  67. Fractint releases, so that is the one combination of compiler/assembler
  68. which is pretty much guaranteed to handle FRACTINT in all of its various
  69. mutations.
  70.  
  71. Given that several of FRACTINT's co-authors now prefer (or only have!)
  72. alternate combinations, we have re-arranged the code to (usually) handle
  73. several popular alternatives.  In particular:
  74.  
  75. Microsoft C 6.00A and MASM 5.1:
  76. -------------------------------
  77. Just run MAKEFRAC.BAT, which invokes the Microsoft NMK utility using the
  78. files FRACHELP.MAK, FRACTINT.MAK, and FRACTINT.LNK.  Note that the assembler
  79. .OBJ files have been included in the .ZIP file, so that you don't really
  80. need MASM unless you are going to modify one or more of them.  If you ARE
  81. going to modify one of the assembler files, note that the distributed
  82. versions rely on some nifty features added to version 5.1 (like the '.model
  83. medium,c' option) and will not assemble under older versions of MASM without
  84. a LOT of work.
  85.  
  86. Note that C 6.00 (the original release) had some problems.  We never used it
  87. for a Fractint release.  If you don't have the fixed version (6.00A) you
  88. should compile parser.c, loadfile.c, and calcfrac.c with no optimization,
  89. using the /qc option.  There might be other problems, those are the only
  90. ones we're aware of...
  91.  
  92. Warning: FRACTINT.MAK uses C6.00A's most aggressive optimizations.  It is
  93. assumed there is no aliasing.  See Microsoft's documentation on the /Oa
  94. and /Oz options.
  95.  
  96. Microsoft C 5.1:
  97. ----------------
  98. Edit MAKEFRAC.BAT: comment out the two "nmk ..." lines and uncomment
  99. the lines for C5.1.  Then run MAKEFRAC.
  100.  
  101. Quick-C:
  102. --------
  103. FRACTINT is just too big for the interactive Quick-C (QC) environment.
  104. You have to use the command-line variant of Quick-C (QCL).
  105.  
  106. Edit MAKEFRAC.BAT: comment out the two "nmk ..." lines and uncomment
  107. the lines for QuickC.  Then run MAKEFRAC.
  108.  
  109. We're not sure all versions of QuickC work.  2.01 works as of
  110. Fractint version 16.  Depending on how much memory you have available,
  111. you may have to manually compile some modules without the /O option.
  112.  
  113. Turbo-C, Turbo-C++ and TASM
  114. ---------------------------
  115. Sorry, Turbo-C fans, but since version 14.0, FRACTINT requires TC++.
  116. The lack of initialized FAR arrays and structures just did the older Turbo-C
  117. product in.  The *good* news is that some of the FRACTINT authors now
  118. use Turbo-C++, so the odds of released FRACTINT distributions that do
  119. not compile with Turbo products are lower than they used to be.
  120.  
  121. A TCFRACT.PRJ and TCHELP.PRJ file is included for Turbo-C users.  You should
  122. rename these to FRACTINT.PRJ and HC.PRJ before compiling fractint.  
  123.  
  124. With TC++ you'll have to do a manual step for the help system each time you
  125. create a new fractint.exe - see notes in next section.
  126.  
  127.  
  128. Borland C++ 3.0 and 3.1 Users
  129. -----------------------------
  130. Rename the BCFRACT.PRJ and BCHELP.PRJ files to FRACTINT.PRJ and HC.PRJ.
  131. The project file will generate the FRACTINT.HLP file, but you will still
  132. have to run "hc /a" from the DOS command line to append the help
  133. information.
  134.  
  135.  
  136.  
  137. Help System
  138. ===========
  139.  
  140. You'll need to set up the help files to get any online help from a modified
  141. version of Fractint.
  142.  
  143. For MSC users the MAKEFRAC.BAT file contains the necessary steps, you don't
  144. need to do anything special.
  145.  
  146. TC++ users should:
  147.   start by creating HC.EXE using the supplied HC.PRJ file
  148.   run "hc /c" to create the file FRACTINT.HLP
  149.   each time you create a new fractint.exe, afterward run "hc /a" to append
  150.     FRACTINT.HLP to the new FRACTINT.EXE
  151.  
  152. You don't need to understand the rest of this section unless you have a
  153. problem.
  154.  
  155. The source for Fractint's help is in the files HELP.SRC, HELP2.SRC, HELP3.SRC,
  156. HELP4.SRC, and HELP5.SRC.  The format of these files is described in HC.DOC.
  157.  
  158. The program HC.C ("help compiler") is used to convert the help text into
  159. the form Fractint uses at run time.
  160.  
  161. Running "hc /c" compiles HELPx.SRC.  It produces the file HELPDEFS.H for
  162. use when compiling Fractint, and the file FRACTINT.HLP.
  163. Running "hc /a" appends the FRACTINT.HLP file to FRACTINT.EXE to make the
  164. compiled help info available at run time.
  165.  
  166.  
  167. Overlays
  168. ========
  169.  
  170. Note: generally you won't have to worry about this!
  171. Only the addition of huge code (new overlays), or work which changes the
  172. relationship between major components of Fractint, are likely to affect
  173. the overlay structure.    However, if you make changes in a module which has a
  174. comment at the start saying it is an overlay, please follow the guidelines
  175. for use of ENTER_OVLY and EXIT_OVLY described after the next paragraph.
  176.  
  177. Fractint uses the Microsoft Link overlay feature, to reduce the runtime
  178. memory required (which would otherwise exceed what DOS can give it.)
  179. Some caution is required with overlays.  Those source modules which are
  180. part of an overlay have a comment to indicate this at the start.  See the
  181. fractint.lnk file for the current overlay structure.
  182. Some notes about overlays:
  183.   o The obvious one: control should not switch to different overlays
  184.     frequently, else Fractint will become sluggish.  If the overlay structure
  185.     changes, a test from floppy disk with no disk caching is a good idea.
  186.   o The linker cannot detect indirect calls (e.g. thing=routinename;
  187.     (*thing)();) to an overlay.  Routines in overlays should not be called
  188.     indirectly, except from within the same overlay.
  189.   o The overlay manager logic (inserted by the linker) does handle calls
  190.     from within one overlay to another - the new overlay is brought in
  191.     from disk (displacing the old one in memory), when the subroutine
  192.     finishes the old overlay is brought back into memory.
  193.   o The overlay manager logic does not handle situations like the following:
  194.     overlayA calls residentB(), which calls overlayC().  OverlayC is loaded
  195.     and executed ok, eventually control returns to residentB ok, BUT the
  196.     return from there to overlayA does NOT reload overlayA!  Fractint has
  197.     constructs called ENTER_OVLY and EXIT_OVLY to circumvent this problem.
  198.  
  199. Guidelines for routines in overlayed modules:
  200.   o If the routine is local, declare it "static" to ensure this and to
  201.     make analysis of relationships among overlays easier.
  202.   o If the routine is called from external code (resident, or in another
  203.     overlay), the first executable line in the routine must be:
  204.       ENTER_OVLY(OVLY_XXX); /* XXX is the module name */
  205.     Each "return" from the routine (incl. the implicit one at the end) must
  206.     be preceded by:
  207.       EXIT_OVLY;
  208.   o When creating a new overlay XXX, add a new OVLY_XXX value to Fractint:
  209.     Fractint.h has a define for each OVLY_XXX value.  Miscres.c has a
  210.     routine "restore_active_ovly" which needs a new line for OVLY_XXX.
  211.     The source module needs a dummy routine "xxx_overlay".
  212.  
  213.  
  214. Where the Goodies are
  215. =====================
  216.  
  217. It has come to our attention that people who have no interest in fractals
  218. at all have been wandering through the FRACTINT source code just to get at
  219. some of the neat tricks buried therein.  Here are a few hints as to where
  220. to look:
  221.  
  222. FRACTINT.C    - The main routine.  Nothing special here.
  223. FRACTINT.H    - General Include file.  Nothing special here, either.
  224. FRACTYPE.H    - Fractal type-specific Include file.
  225.  
  226. PROMPTS.C    - The full-screen prompting code (using support routines
  227.           in VIDEO.ASM)
  228. CMDFILES.C    - Command line and sstools.ini parsing.
  229.  
  230. FRACTALS.C,    - Most of the fractal-specific code.  If you want to know
  231.  CALCFRAC.C,      how a fractal is calculated, look in here.  Specific
  232.  FRACSUBR.C      speed-em-up support for special fractal types is in:
  233.  FRACSUBA.ASM
  234. CALCMAND.ASM    - Mandelbrot/Julia set calculations.
  235. NEWTON.ASM    - Newton calculations
  236. LORENZ.C    - Attractor fractals and IFS
  237. JB.C        - "Julibrot" fractal type calculations
  238. TESTPT.C    - "Roll-your-own" fractal routine
  239. MPMATH_C.C,    - Mark Peterson's "fast-math" support routines.
  240.  MPMATH_A.ASM,      (this stuff puts some of the routines supplied by your
  241.  FPU387.ASM,      favorite "C" compiler to shame!)
  242.  FPU087.ASM,      ...
  243.  FMATH.H,      ...
  244.  MPMATH.H      ...
  245. PARSER.C    - The "type=formula" formula parser routines
  246. LSYS.C        - L-Systems code
  247.  
  248. VIDEO.ASM    - Assembler code containing all of the video routines
  249.           (setting up the video, reading/writing pixels, zoom-box
  250.           code, color-cycling, graphics-to-text "help" switch,
  251.           ... with help from the routines below for special adapters:
  252. LOADMAP.C    - Load .map files.
  253. TARGA.C,    - TARGA Video Routines
  254.  TARGA.H,      ...
  255. FR8514A.ASM    - 8514/A Routines
  256. TPLUS.C     - Targa+ video routines
  257.  TPLUS.H      ...
  258.  TPLUS_A.ASM      ...
  259. HGCFRA.ASM    - Hercules Video Routines
  260. DISKVID.C    - "DISK'RAM" video routines
  261. YOURVID.C    - "Roll-your-own" video routines
  262.  
  263. GENERAL.ASM    - General assembler code having nothing to do with fractals.
  264.           Lots of the tricky stuff is in here, and many of the "C"
  265.           routines that perform tricky functions rely on support
  266.           code buried in here.    In particular, this routine has the:
  267.             CPU, FPU Detectors
  268.             Keyboard routines
  269.             Mouse routines
  270.             Expanded memory routines
  271.             32-bit scaled integer multiply and divide routines
  272.  
  273. ENCODER.C    - GIF Encoder routine.
  274. GIFVIEW.C,    - GIF Decoder routines.
  275.  DECODER.C,
  276.  TGAVIEW.C,      (including a TARGA-format decoder currently used only for
  277.  F16.C,       loading obsolete .tga format "Continuous Potential" files)
  278.  TARGA_LC.H      ...
  279. LOADFILE.C    - Loads the Fractint parameter info from a GIF file.
  280.  LOADFDOS.C      subroutines for DOS Fractint only
  281.  
  282. LINE3D.C,    - 3D manipulation routines
  283.  3D.C
  284. PLOT3D        - 3D subroutines for LINE3D.C and LORENZ.C
  285.  
  286. ROTATE.C    - routines which "spin" the VGA video-DAC.
  287. EDITPAL.C    - palette-editing mode
  288.  
  289. HELP.C        - HELP support
  290. INTRO.C     - title screen
  291.  
  292. ZOOM.C        - Zoombox manipulation.
  293.  
  294. PRINTER.C,    - The Printer Routines
  295.  PRINTERA.ASM      Data used by PRINTER.C
  296.  
  297. MISCRES.C    - Miscellaneous resident subroutines; nothing special.
  298. MISCOVL.C    - Miscellaneous overlayed subroutines; includes <B>atch
  299.           command.
  300. REALDOS.C    - Some subroutines isolated from Windows development work;
  301.           nothing special in here.
  302.  
  303. PORT.H        - Some portability stuff, nothing special here.
  304.  
  305. How things are set up
  306. =====================
  307. I've had to go through a lot of the code to figure out how things are set
  308. up.  These are my rough notes, which I'm including in case they can help
  309. someone else. -- Ken Shirriff
  310.  
  311. The control flow is very confusing.  Here are some details:
  312.  
  313. Each fractal type has an entry in the fractalspecific table in fractalp.c.
  314. Entries that are not displayed are marked with an asterisk.  Each entry is
  315. marked as int or not int, and either has a pointer to another entry
  316. (tofloat) or NOFRACTAL.  If you select float and the type is int or vice
  317. versa, you will end up with the tofloat type.  (e.g. If you select entry
  318. MANDEL, and select floating point, you will get entry MANDELFP).  There are
  319. also pointers tojulia and tomandel, which allow you to switch between mandel
  320. and julia.  The four functions listed are curfractalspecific->orbitcalc,
  321. curfractalspecific->per_pixel, curfractalspecific->per_image, and
  322. curfractalspecific->calctype.
  323.  
  324. main calls calcfracinit.
  325. calcfractint: this sets up curfractalspecific, which is the appropriate entry
  326.     from the fractalspecific table.  This routine does the int/float
  327.     conversion.
  328.  
  329. main calls calcfract, which calls timer, which calls perform_worklist
  330. perform_worklist calls curfractalspecific->per_image, which is eg.  MandelSetup
  331. MandelSetup: sets calctype to curfractalspecific->calctype, or for special
  332.     cases (eg. decomposition) to StandardFractal
  333.  
  334. perform_worklist calls solidguess (or whatever drawing system)
  335. solidguess calls *calctype for each pixel; calctype is eg. StandardFractal
  336.  
  337. StandardFractal calls curfractalspecific->per_pixel once, and then loops over
  338.     each iteration calling curfractalspecific->orbitcalc.  These routines
  339.     are eg.  mandel_per_pixel and JuliaFractal.
  340.  
  341.  
  342.  
  343. Here is the structure of the main routine:
  344.  
  345. main()
  346. {
  347.     initialize things
  348. restorestart:
  349.     if loading, look after specifying image
  350. imagestart:
  351.     while (adapter<0) {
  352.     process keys from short main menu
  353.     }
  354.  
  355.     while (1) {
  356.     if (calc_status != 2 || showfile==0) {
  357.         initialize videoentry from videotable[adapter]
  358.         initialize size, color, etc. from videoentry
  359.         setvideomode()
  360.     }
  361.     if (showfile==0) {
  362.         load file
  363.     }
  364.     calcfracinit();
  365.     save corners, zoom data
  366.     if (showfile != 0) {
  367.         calcfract(); /* calculates the fractal until interrupted */
  368.     }
  369. resumeloop:
  370.     if (no key pressed) {
  371.         set keypress = 13 to continue
  372.     } else if (key pressed) {
  373.         check input key
  374.     } else if (batch mode) {
  375.         look after batch key
  376.     }
  377.  
  378.     process key from long menu
  379.     }
  380. }
  381.  
  382.  
  383. How the video entries are managed:
  384.  
  385. get_video_mode(fractal_info): This routine is used to select a video mode
  386.     to match a picture we're loading.  It loads vidtbl and then  tries to
  387.     find a video mode that matches that in fractal_info.  Asks the user to
  388.     select one if there's no good match.  Figures out how to reduce the image
  389.     to fit the screen.
  390.  
  391. select_video_mode(curmode): This is the main-menu routine for the user to
  392.     pick a video mode.  picks default video mode, lets user select mode
  393.     from menu, copies entry to videoentry, puts entry in videotable if not
  394.     there, calls update_fractint_cfg if key reassigned, returns key
  395.     corresponding to mode
  396.  
  397. check_vidmode_key(option, keypress): if keypress corresponds to a videomode in
  398.     videotable (for option 0) or vidtbl (for option 1) return the videomode
  399.     index, else -1.
  400.  
  401. check_vidmode_keyname: converts ascii key name into key number
  402.  
  403. adapter_detect: checks for type of video (ega, cga, etc) and set video_type,
  404. mode7text, textsafe.
  405.  
  406. load_videotable: reads the entries in fractint.cfg into vidtbl
  407.     copies entries with an associated function key into videotable
  408.  
  409. load_fractint_cfg: reads video modes in fractint.cfg into vidtbl
  410.     (or copies from videotable) if fractint.cfg missing or bad
  411.  
  412. update_fractint_cfg: writes the entry in videoentry into the fractint.cfg file.
  413.  
  414. vidtbl: contains the video modes from fractint.cfg
  415. videotable: contains video modes with function keys; initialized in video.asm
  416. video_type: contains type: hgc, egc, cga, mcga
  417.  
  418.  
  419. Here is how the floating point modes are set up.
  420. parser.c uses the MathTypes:
  421. D_MATH: uses double precision routines, such as dStkMul, and FPUsincos
  422.     This is used if we have a fpu.
  423. M_MATH: uses MP type (mantissa, exponent).  These routines such as mStkAdd
  424.     call MPCadd, which call pMPadd, which calls MPadd086 or MPadd386.
  425.     The MP routines work on multiple precision, MPC works on complex pairs
  426.     of multiple precision.
  427. L_MATH: uses integer math.  Routines such as lStkAdd.
  428.